Updates to BUILDING.md to incorporate dependencies #1107
Conversation
Enumerating Rust's OS package dependencies
Adding disk space requirements.
BUILDING.md
Outdated
| #### Adequate Disk Space | ||
|
|
||
| The build process artifacts and resulting images can consume in excess of 4GB in the local directory. |
There was a problem hiding this comment.
System Requirements might be a better heading, then we can add recommendations for storage + memory + compute.
Systems should have at least 80 GB of storage available. There's quite a lot of overhead from the intermediate Docker layers that are created.
BUILDING.md
Outdated
|
|
||
| Ensure the following OS packages are installed: | ||
|
|
||
| - `build-essential` |
There was a problem hiding this comment.
Fedora doesn't have a direct equivalent to this. It might be better to split it into separate commands, with an Ubuntu example and a Fedora example.
BUILDING.md
Outdated
|
|
||
| The build process artifacts and resulting images can consume in excess of 4GB in the local directory. | ||
|
|
||
| #### Operating System Packages |
There was a problem hiding this comment.
Maybe call this "Linux" since it'll live at the same level as "Rust" and "Docker". Or we can fold it into the previous System Requirements section.
Co-authored-by: Ben Cressey <[email protected]>
Co-authored-by: Ben Cressey <[email protected]>
BUILDING.md
Outdated
| @@ -8,6 +8,29 @@ You can skip to the [setup guide for Kubernetes](QUICKSTART-EKS.md) or the [setu | |||
|
|
|||
| ### Dependencies | |||
|
|
|||
| #### System Requirements | |||
|
|
|||
| The build process artifacts and resulting images can consume in excess of 4GB in the local directory. | |||
There was a problem hiding this comment.
Let's bump up this number quite a bit as @bcressey mentioned: we're probably safe to say around 80GB.
Updating disk space requirement to 80GB
Issue number:
#1106
Description of changes:
Updating BUILDING.md to articulate missing dependencies.
Testing done:
Executed a build following the instructions.
Terms of contribution:
By submitting this pull request, I agree that this contribution is dual-licensed under the terms of both the Apache License, version 2.0, and the MIT license.